home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / ddoor350.zip / DDOOR.DOC < prev    next >
Text File  |  1992-06-11  |  9KB  |  247 lines
  1.    ===================================================================
  2.                                    D-DooR
  3.  
  4.              Top Doors Statistics Bulletin Generator for RemoteAccess
  5.  
  6.                           Version 3.50   May 2, 1992
  7.  
  8.                    (C) Copyright Victor Magdic 1991,1992
  9.  
  10.                             All Rights Reserved
  11.    ===================================================================
  12.  
  13. Description
  14. ===========
  15.  
  16.  D-DooR is a program for RemoteAccess which will automatically track your door
  17.  usage, and *who* is using them. It will generate "Top Door" stats, as well
  18.  as "Top Door User" stats.  D-DooR has been tested on RA 1.10 and 1.11
  19.  -it should work fine with future versions as well, but that will depend on
  20.  what changes are made to the RA file structures.
  21.  
  22.  
  23. How much does it cost?
  24. ======================
  25.  
  26.   This utility is FREE!  If you like it you can continue to use it
  27.   for as long as you like free of charge!
  28.  
  29.   If you do decide to use it, I would be excited to hear from you !!
  30.   I encourage you to send me a postcard at the address listed below (see
  31.   the end of this text file). It will cost you practically nothing, and
  32.   will let me know you're enjoying the program. It will also give me
  33.   incentive to keep improving the program and make it even better!
  34.  
  35.  
  36. Door Name Data File
  37. ===================
  38.  
  39. You must create a data file called DDOOR_ID.DAT which contains information
  40. about your doors. The file must be a plain ASCII text file.  Each door which
  41. you want to keep track of has three lines of information associated with
  42. it, up to 99 doors can be specified in this way:
  43.  
  44.       Line 1.  Three letter code to identify the door
  45.       Line 2.  The door name (as you want it to appear in the bulletin).
  46.       Line 3.  The number of times the door has been accessed. When you are
  47.                first creating this file, set this value to 1 (setting it to
  48.                zero will create an error when you run DDOOR).
  49.  
  50. Example of DDOOR_ID.DAT:
  51.  
  52.       TW2                    <--- three letter code
  53.       TradeWars 2002         <--- door name
  54.       1                      <--- times used
  55.       AC6
  56.       Alpha Colony 6
  57.       1
  58.       YTR
  59.       Yankee Trader
  60.       1
  61.  
  62.  ** do not put any blank lines in the data file, and be sure you maintain the
  63.     proper order (id, doorname, times used).
  64.  
  65.  ** there is a sample DDOOR_ID.DAT file included which you can modify.
  66.  
  67.  ** TIP: You don't have to start the door counter at 1, you can start it at
  68.          any number you want. For example, if you have been running Tradewars
  69.          for some time, you can make an estimate of how many times it has been
  70.          used and put that number in instead.
  71.  
  72.  ** TIP: Since the data file is a plain ASCII text file, you can modify it
  73.          at any time and change the values. So if you want to restart
  74.          the counters, just set them all to 1 (not zero).
  75.  
  76.  
  77. Location of Files
  78. =================
  79.  
  80.  DDOOR_ID.DAT must be placed in the main RA directory as specified by the RA
  81.  environment variable (e.g. D:\RA or whatever). DDOOR.EXE can be placed either
  82.  in the main RA directory, or anywhere in your path (if you are running
  83.  multi-node see below).
  84.  
  85.  
  86.     Multi-Node Considerations
  87.     -------------------------
  88.  
  89.     D-DooR uses information from EXITINFO.BBS to update the door-user-counter
  90.     (see below), and it will look for EXITINFO in the current directory. At
  91.     the same time, D-DooR uses the RA environment variable to locate its
  92.     data files.  This makes multi-node setups easy. All you have to do
  93.     is run D-DooR from your node directory (where the exitinfo.bbs will
  94.     be stored), and D-DooR will handle the rest. It's not necessary to
  95.     have a copy of DDOOR.EXE in each node directory, provided that
  96.     DDOOR.EXE is somewhere in your path.
  97.  
  98.  
  99. Updating Door Counters
  100. ======================
  101.  
  102.   To update the counter for a particular door, run DDOOR in your batch file
  103.   after you run the door and specify the three letter ID code that corresponds
  104.   to that door on the command line.
  105.  
  106.     Example:    DDOOR AC6        ; would update the counter for Alpha Colony 6
  107.                                    if you were using the example data file shown
  108.                                    above.
  109.  
  110.  
  111.                 DDOOR TW2        ; would update the counter for Tradewars 2002
  112.  
  113.  
  114.   Note:  If you enter an ID code that is not defined in the data file
  115.          (DDOOR_ID.DAT) it will simply be ignored.
  116.  
  117.   Note:  The ID codes are not case sensitive, so AC6, ac6, and Ac6 would all
  118.          be treated the same.
  119.  
  120.  
  121. Updating "User" Counters
  122. ========================
  123.  
  124.   D-DooR automatically updates the "top door user" counter every time it
  125.   is run. No specific command line switches are required.
  126.  
  127.   Note: At present, there is no way to edit the top-door-user counter
  128.         file (DDOOR_NA.DAT). Perhaps in a future release, a simple editor will
  129.         be included. For now, if you want to restart the "user" counter, you
  130.         will have to delete DDOOR_NA.DAT.
  131.  
  132.  
  133. Generating Bulletins
  134. ====================
  135.  
  136.   Bulletins are NOT automatically generated every time you update the door
  137.   counter.  This is done in the interest of speed, since generating bulletins
  138.   every time a user accesses a door can be time consuming, particulary if you
  139.   have a slow hard drive.  (TIP: if you want to generate bulletins after every
  140.   door a method is explained below)
  141.  
  142.   In order to generate the bulletins you must use the /G parameter on the
  143.   command line.
  144.  
  145.       Example:  DDOOR /G
  146.  
  147.   This will create four files in your RA Textfiles directory (as defined
  148.   in RACONFIG):
  149.  
  150.         DDOOR_ID.ANS   Ansi version of Top Doors Bulletin
  151.         DDOOR_ID.ASC   Ascii    "   "   "   "       "
  152.         DDOOR_NA.ANS   Ansi version of Top Door Users Bulletin
  153.         DDOOR_NA.ASC   Ascii  "     "   "   "     "      "
  154.  
  155.  
  156.   By default, DDOOR ranks the Top 10 Doors/Users and only puts these in the
  157.   bulletin. If you want more, specify the number on the command line as follows:
  158.  
  159.                DDOOR /G 15           ; would generate a "Top 15" bulletin.
  160.  
  161.  
  162.   ** It is recommended that you generate bulletins once per day
  163.      in your daily maintenance routine.  If you don't mind the extra
  164.      delay, and want to generate new bulletins after every door is used, just
  165.      generate the bulletins separately after you update the door counter. For
  166.      example, your batch file might look like this:
  167.  
  168.  
  169.         REM batch file for TW2002 -game one
  170.         @echo off
  171.         cd\ra\doors\tw2002
  172.         tw2002 -qbbs
  173.         cd\ra
  174.         rem update door counter for Tradewars 2002
  175.         DDOOR TW2
  176.         rem generate bulletins for top 20 doors/users
  177.         DDOOR /G 20
  178.  
  179.  
  180.      Using Handles
  181.      -------------
  182.  
  183.         By default, D-DooR uses REAL names when it creates the "top door
  184.         user" bulletins. If you want to use HANDLES instead, specify the
  185.         /H switch along with the /G switch, example:
  186.  
  187.                  DDOOR /G /H 12
  188.  
  189.         would generate top 12 "door user" stats (and top 12 "door
  190.         stats"), using Handles instead of Real names.
  191.  
  192.  
  193. Quick Summary of Command Line Options
  194. =====================================
  195.  
  196.    To Update Counters:
  197.  
  198.        DDOOR idcode           ; where idcode is the three letter door identifier
  199.                                 specified in the control file (DDOOR_ID.DAT)
  200.  
  201.  
  202.    To Generate Bulletins:
  203.  
  204.        DDOOR /G [/H] [RANK]   ; where /H uses handles and RANK is the
  205.                                 number of doors/users you want "ranked"
  206.                                 in the bulletins.
  207.  
  208.    Other:
  209.  
  210.        DDOOR /?               ; help screen
  211.  
  212.  
  213. Legal Disclaimer
  214. ================
  215.  
  216.   No warranty for this utility is either expressed or implied. The author
  217.   shall not be held liable for any direct or consequential damage which
  218.   arises from the use of this utility. I make no gaurantees it will work
  219.   properly on your system.
  220.  
  221.  
  222.  
  223. Suggestions always welcome!
  224. ===========================
  225.  
  226.   If you have any suggestions for improvement or wish to report any bugs,
  227.   you can reach me through my BBS:
  228.  
  229.  
  230.                The DeAdZoNe        ...dare to enter The DeAdZoNe....
  231.                (416) 507-2159
  232.                Victor Magdic -SysOp
  233.                FidoNet: 1:259/427
  234.                TeleNet Canada: 20:22/4
  235.  
  236.  
  237.   or by writing to:
  238.  
  239.               Victor Magdic
  240.               424 Camden Circle
  241.               Mississauga, Ontario
  242.               L4Z 2P4
  243.               CANADA
  244.  
  245. ================================================================ end
  246.  
  247.